home *** CD-ROM | disk | FTP | other *** search
/ PsL Monthly 1993 December / PSL Monthly Shareware CD-ROM (December 1993).iso / prgmming / dos / pascal / shazam.exe / README < prev    next >
Text File  |  1992-09-01  |  16KB  |  452 lines
  1.                        ******************
  2.                        Welcome to SHAZAM!
  3.                        ******************
  4.  
  5. Documentation for SHAZAM is both "online" and "offline":
  6.  
  7. [X] ONLINE - The context-sensitive portion is cross-referenced with
  8.     the manual, most of which is also in HyperText format.
  9.  
  10. [X] OFFLINE - The PRINTDOC program is about to be generated and
  11.     compiled.  It will print the Technical Manual and demonstration
  12.     programs with your choice of formats and margins.  The "Test
  13.     print" option is a 2-page report, so you can make adjustments and
  14.     try different settings.
  15.  
  16.     All source for units and example programs is included.  You can
  17.     re-use dialogs, hints and help text files as "plug n' play"
  18.     elements of your own programs.
  19.  
  20.  
  21. CONTENTS
  22. --------
  23. 1 - Getting started
  24. 2 - Notes
  25. 3 - Installation
  26. 4 - Units
  27. 5 - Examples
  28. 6 - Overview
  29. 7 - Acknowledgements
  30. 8 - Technical Support
  31.  
  32.  
  33.  
  34. 1 - GETTING STARTED
  35. ===================
  36. If you are upgrading from version 1.x,  you MUST read UPGRADE.DOC.
  37.  
  38. To give you an idea of what SHAZAM can do, the following...
  39.  
  40.     KEYWORDS & ITEMS         HINTS
  41.         |                       |
  42.         V                       V
  43.     ----------------------------------------------
  44.     [ submenu ] file         ;;hint for file stuff
  45.     open   f3                ;;open a file
  46.     save   f2                ;;save window
  47.  
  48.     [ status ]
  49.     f1 Help                  ;;call HyperText help
  50.     alt-x exit cmQuit        ;;return to DOS
  51.     ----------------------------------------------
  52.  
  53. ...creates a ready-to-run EXE with Help Text & Hints, using overlays
  54. and resources, recovers overlay heap for EXEC, and runs under DOS 2.x
  55. or higher.  By default, SHAZAM allows for use of ExecSWAP, so the
  56. application is unitized (encapsulated) and you get Swap-To-Disk/EMS
  57. capability too, with minimum overhead, less than <6k.
  58.  
  59. No kidding.
  60.  
  61. Type the above into a file with an *.DEF extension & press Ctrl-F9.
  62.  
  63. Don't want overlays?  Use the "/O-" switch, from the DOS prompt or
  64. SETUP|Code dialog.  No ExecSwap?  Use "/X-".  Code, instead of
  65. resources?  Use "/1".  And so on...
  66.  
  67. Now, for an actual "Exec", you would have to add custom code, BUT
  68. there's a routine in GENERAL.PAS called "VisionExec" (just like
  69. DOS.Exec) which takes care of Turbo Vision housekeeping for you.
  70.  
  71. There's also pre-done events called "hdLittleDOS", "hdMediumDOS" and
  72. "hdBigDOS" for shelling to the DOS prompt.  Run the ED*.DEF examples
  73. and see the help text for details.
  74.  
  75. The basic idea of using SHAZAM is:  It codes the "FrameWork" for you,
  76. so you can concentrate on "fleshing out" custom code and Help Text.
  77. This gives you the freedom to experiment with interface design, since
  78. you can re-generate & re-compile anytime with one keystroke (Ctrl-F9).
  79.  
  80.  
  81. To accelerate your learning curve
  82. ---------------------------------
  83. Start with the ADEMO*.DEF series, in IDE mode.  Type "C:>shazam", use
  84. "File|OPEN" to select a file, then press Ctrl-F9, which will
  85. generate, compile & run a program.
  86.  
  87.  
  88. An alternative
  89. --------------
  90. Print the ADEMO*.DEF series, then generate all programs using
  91. command-line mode.  Type "C:>shazam ademo*/m" to generate, compile &
  92. run the whole series at once.
  93.  
  94.  
  95. Note on HELP
  96. ------------
  97. SHAZAM generated programs will automatically support ALT-F1 (to view
  98. previous help screens) if you patch HELPFILE.PAS with ALTF1.PAT
  99.  
  100.  
  101.  
  102. 2 - NOTES
  103. =========
  104. [X] Copyrights
  105.  
  106.     Please respect any and all copyright notices.
  107.  
  108.     All parts of this software are copyrighted, including but not
  109.     limited to programs, documentation, source-code and examples.
  110.  
  111.     As a licensed user, you may use the example programs.  However,
  112.     they may not be sold, given away or otherwise distributed without
  113.     written permission.
  114.  
  115.     Also, as a licensed user, you are free to incorporate examples
  116.     (definitions, help text, etc.) and source code into your programs.
  117.  
  118.  
  119. [X] Documentation
  120.  
  121.     You should view, or print, all *.DOC files.  Do AINTRO.DOC first,
  122.     before starting on the ADEMO*.DEF series.  You may also want to
  123.     print the ADEMO*.DEF files as you go along.  Since SHAZAM
  124.     automatically loads support files along with definitions, you can
  125.     use "File|Print all" or Ctrl-F4 to print all editor windows
  126.     currently loaded into the Desktop.
  127.  
  128.  
  129. [X] Interactive and Command-Line modes
  130.  
  131.     Both are supported in the same program.  Type "C:\>shazam /?" at
  132.     the command-line for a list of switches, or "C:\shazam" and
  133.     select the SETUP|Code dialog.
  134.  
  135.  
  136. [X] PATCHES
  137.  
  138.     A number of tested patches have been included.  Browse the *.PAT
  139.     files for details.
  140.  
  141.     APP.PAT - DesqView patch for APP.PAS
  142.     ------------------------------------
  143.     If you want all your Turbo Vision programs to run under DesqView,
  144.     APP.PAT contains a simple modification to accomplish this.  If
  145.     you make this patch, activate the "define" in the "COMPILER.PAS"
  146.     file by adding a dollar sign:
  147.  
  148.     {DEFINE desqview}   -->  {$DEFINE desqview}
  149.  
  150.     This is so the "UserScreen" and "CopyScreen" routines in
  151.     GENERAL.PAS will recognize the DesqView patch.
  152.  
  153.  
  154.     EDLOAD.PAT - for original EDITORS
  155.     ---------------------------------
  156.     An improved version of EDITORS comes with SHAZAM.  If you want to
  157.     use the original, you must correct this bug in the load/store
  158.     methods, or your program will hang during Desktop load/store.
  159.  
  160.  
  161. [X] ONLINE HELP
  162.  
  163.     SHAZAM comes with its own help file, but if you need Online Help
  164.     for Turbo Vision, don't forget THELP.COM (shipped with Turbo
  165.     Pascal).  It provides memory resident help/reference on both
  166.     Turbo Pascal & Turbo Vision at a relatively low cost in memory
  167.     overhead (about 30k).
  168.  
  169.  
  170.  
  171. 3 - INSTALLATION
  172. ================
  173. If you need to restore the example code, you can re-run INSTALL.  All
  174. existing files will be over-written.
  175.  
  176.  
  177.  Programs
  178.  --------
  179.   INSTALL.EXE - Installation program
  180.   INSTALL.DAT - Installation data
  181.  
  182.  Archives
  183.  --------
  184.     BABEL - Multiple Language Editor
  185.       DEF - Commonly used Definitions
  186.       DLG - Commonly used Dialogs
  187.  EXAMPLES - Sample definitions and source code
  188.    EXSWAP - Source code for EXECSWAP & EXECPROC
  189.   GENERAL - General purpose code for Turbo Vision
  190.     PATCH - Turbo Vision patches
  191.    SHAZAM - Program, Help and Help Compiler
  192.       TXT - Commonly used Help Text
  193.  
  194.  
  195. Instant INSTALL
  196. ---------------
  197. Installation was done using "Instant INSTALL", a generic INSTALL
  198. program which supports multiple diskettes using ARC/LZH/ZIP formats
  199. and de-archive programs.  For more information, use the "/?" switch at
  200. the DOS prompt:
  201.  
  202.     C:\>a:install/?
  203.  
  204.  
  205. SHAZAM program installation creates the following directory structure:
  206.  
  207.     ?:\SHAZAM2\
  208.               \DEF\
  209.               \DLG\
  210.               \TXT\
  211.  
  212. You are free to re-arrange things to suit you.  Use the SETUP |
  213. Directory dialog to let SHAZAM know where things are.  The most
  214. likely change is to move the program files -- SHAZAM.EXE, SHAZAM.HLP
  215. and SZHC.EXE -- to a directory on your system PATH.
  216.  
  217.  
  218. DISK SPACE
  219. ----------
  220. Although three megabytes of disk space are needed to install SHAZAM
  221. and run the PRINTDOC program, you can erase the examples and keep
  222. only the program files.
  223.  
  224. To free up disk space (ie: before a backup), run CLEAN.BAT.  This
  225. erases only generated files, which you can easily re-create.
  226.  
  227.  
  228. PORTABLE SHAZAM
  229. ---------------
  230. If you must work "on-site" to develop an interface, it is possible to
  231. fit SHAZAM, the compiler (TPC.EXE) and the Turbo Vision units on a
  232. high-density diskette of either size.
  233.  
  234. The bare essentials are:
  235.  
  236.     [X] SHAZAM.EXE - main program.  (SHAZAM.HLP is optional)
  237.     [X] SZHC.EXE - new Help Compiler (old TVHC.EXE may be used)
  238.  
  239. ...plus the compiler and TV units, of course.
  240.  
  241.  
  242.  
  243. 4 - UNITS
  244. =========
  245. Only the Turbo Vision units are needed to compile a generated
  246. application.  However, a number of utility & workhorse units are
  247. included, as used by SHAZAM itself and many of the examples:
  248.  
  249.  
  250. GENERAL.PAS   Standard events, dialog